6个Spring Boot处理异常的小技巧
详细介绍讲解如何在Spring Boot应用程序中处理产品相关的自定义异常并进行全局处理。
在Spring框架中,@ControllerAdvice是全局异常处理机制,用于集中处理应用程序中发生的异常。
当任何控制器方法(例如REST端点)抛出异常时,该异常会被@ControllerAdvice注解的类捕获。
@ControllerAdvice类中的@ExceptionHandler方法用于处理特定类型的异常,并返回适当的响应。
本文我们通过一个实际场景的例子来详细说明,在Spring Boot应用程序中处理产品相关的自定义异常并进行全局处理的情况。
步骤:
1 创建自定义的ProductNotFoundException:
在这一步中,我们创建一个自定义异常类ProductNotFoundException
,它继承自RuntimeException
。这个自定义异常用于表示系统中找不到产品的情况。通过创建自定义异常,我们可以提供更具体的错误信息。
public class ProductNotFoundException extends RuntimeException {
public ProductNotFoundException(Long productId) {
super(“Product not found with ID: “ + productId);
}
}
解释:
自定义异常用于捕获应用程序特定的错误场景。 在这种情况下,我们在异常消息中包含了 productId
,以提供有关缺失产品的详细信息。
2 创建产品服务(Product Service):
在这步,我们创建一个ProductService
类,负责获取产品信息。如果找不到产品,会抛出ProductNotFoundException
。
@Service
public class ProductService {
public Product getProductById(Long productId) {
// 模拟获取产品的逻辑
Product product = getProductFromDatabase(productId);
if (product == null) {
throw new ProductNotFoundException(productId);
}
return product;
}
// 模拟从数据库获取产品的方法
private Product getProductFromDatabase(Long productId) {
// 在这里实现您的数据库逻辑
// 如果找不到产品,则返回null
return null;
}
}
解释:
ProductService
封装了与产品相关的业务逻辑。getProductById
方法模拟从数据库或其他数据源获取产品。如果找不到产品(基于模拟),会抛出 ProductNotFoundException
。
3 创建全局异常处理器(Global Exception Handler):
这一步涉及使用@ControllerAdvice
创建一个全局异常处理器。该处理器负责全局捕获ProductNotFoundException
,并返回自定义错误响应。
@ControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(ProductNotFoundException.class)
public ResponseEntity<ErrorResponse> handleProductNotFoundException(ProductNotFoundException ex) {
ErrorResponse errorResponse = new ErrorResponse(HttpStatus.NOT_FOUND.value(), ex.getMessage());
return ResponseEntity.status(HttpStatus.NOT_FOUND).body(errorResponse);
}
}
解释:
@ControllerAdvice
将该类标记为全局异常处理器,使其能够处理来自多个控制器的异常。处理器内的 @ExceptionHandler
方法捕获ProductNotFoundException
。它使用异常中的自定义错误消息构建一个包含404 Not Found状态码的 ErrorResponse
对象。处理器返回包含错误详细信息的JSON响应。
4 创建自定义错误响应类(Custom Error Response Class):
我们定义一个自定义的错误响应类ErrorResponse
,以便在应用程序中统一结构化错误消息。
public class ErrorResponse {
private int statusCode;
private String message;
public ErrorResponse(int statusCode, String message) {
this.statusCode = statusCode;
this.message = message;
}
// Getter方法
}
解释:
ErrorResponse
类提供了一个标准化的错误响应格式。它包含HTTP状态码和描述错误的消息字段。
5 产品控制器(Controller):
在这一步中,我们创建一个控制器ProductController
,负责处理根据产品ID获取产品的请求。
@RestController
@RequestMapping("/api/products")
public class ProductController {
@Autowired
private ProductService productService;
@GetMapping("/{productId}")
public ResponseEntity<Product> getProduct(@PathVariable Long productId) {
Product product = productService.getProductById(productId);
return ResponseEntity.ok(product);
}
}
解释:
ProductController
定义了一个端点,用于根据产品ID获取产品详细信息。它使用 ProductService
来获取产品。如果找到产品,它将返回包含产品数据的成功响应。
6 测试异常处理:
为了测试异常处理,发送GET请求来获取在系统中不存在的产品信息。这将触发ProductNotFoundException
,并由全局异常处理器返回一个JSON格式的错误消息。
curl -X GET http://localhost:8080/api/products/123
响应:
{
"statusCode": 404,
"message": "Product not found with ID: 123"
}
解释:
测试请求尝试获取一个在系统中不存在的产品的信息,例如ID为123的产品。 结果导致服务层抛出 ProductNotFoundException
异常。标记为 @ControllerAdvice
的全局异常处理器捕获该异常,并构建一个包含404状态码和自定义错误消息的JSON格式错误响应。
顺序流程图
从控制器到使用@ControllerAdvice
进行错误处理的Spring应用程序的流程顺序图:
1 控制器层:
客户端(例如Web浏览器或REST客户端)向Spring应用程序发出请求,通常是向公开的HTTP端点发送请求。
2 控制器方法执行:
Spring MVC框架根据请求映射注解(如 @GetMapping
或@PostMapping
)将传入的请求路由到适当的控制器方法。控制器方法执行并执行其业务逻辑。
3 异常发生:
在执行控制器方法的过程中,由于各种原因可能会抛出异常。这可能是由于业务逻辑错误、验证失败或任何其他意外问题。
4 异常传播:
一旦在控制器方法内部抛出异常,它就会开始沿着调用堆栈向上传播。
**5 @ControllerAdvice类:
异常向上传播,直到达到使用 @ControllerAdvice
注解的全局异常处理器类为止。
6 @ExceptionHandler方法:
在 @ControllerAdvice
类中,定义了一个或多个@ExceptionHandler
方法来处理特定类型的异常。
7 匹配异常处理器:
Spring框架根据方法的参数类型识别出适当的 @ExceptionHandler
方法来处理特定的异常类型。
8 异常处理:
匹配的 @ExceptionHandler
方法执行以处理异常。此方法可以执行诸如记录错误、构建错误响应或执行任何其他自定义操作的任务。
9 生成响应:
@ExceptionHandler
方法通常生成一个错误响应,可以是JSON响应、HTML页面或任何其他响应格式。
10 响应发送给客户端:
由 @ExceptionHandler
方法生成的错误响应发送回原始请求的客户端。
11 客户端接收错误响应:
客户端接收错误响应,并根据需要处理错误信息。例如,它可以向用户显示错误消息或以编程方式处理错误。
推荐书单
《精通Spring Boot 2.0》
本书详细阐述了与Spring Boot 2.0相关的基本解决方案,主要包括定制auto-configuration、Spring CLI和Actuator、Spring Cloud和配置操作、Spring Cloud Netflix和Service Discovery、构建Spring Boot RESTful微服务、利用Netflix Zuul 创建API网关、利用Feign客户端简化HTTP API、构建事件驱动和异步响应式系统、利用Hystrix和Turbine构建弹性系统、测试Spring Boot应用程序、微服务的容器化、API管理器、云部署(AWS)、生产服务监视和z佳实践等内容。此外,本书还提供了相应的示例、代码,以帮助读者进一步理解相关方案的实现过程。
本书适合作为高等院校计算机及相关专业的教材和教学参考书,也可作为相关开发人员的自学教材和参考手册。
购买链接:https://item.jd.com/12639616.html
精彩回顾